Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helpers cleanup #1237

Merged
merged 14 commits into from
Jun 30, 2019
Merged

Helpers cleanup #1237

merged 14 commits into from
Jun 30, 2019

Conversation

JustinDrake
Copy link
Contributor

@JustinDrake JustinDrake commented Jun 30, 2019

Addresses #918. It includes:

  1. Grouping helpers by category
  2. Renamings (for consistency, length, clarity)
  3. Add top-level function comments where missing, and make them consistent
  4. Remove neglected and sometimes misleading terminology section (to be readded post-freeze)
  5. Various other cosmetic cleanups

@JustinDrake JustinDrake added the milestone:June 30 freeze 🥶 Phase 0 spec freeze for long-lived cross-client testnet label Jun 30, 2019
@JustinDrake JustinDrake marked this pull request as ready for review June 30, 2019 13:33
Copy link
Contributor

@CarlBeek CarlBeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a much more sensible ordering of helpers, I really like it! I do have a few comments though:

  • For consistency's sake, I think the Terminology section should be removed from 1_custody.md too.
  • I am not a fan of the function naming used in the Misc section of 0_beacon_chain.md. Based on the name alone, I don't think I would be able to determine what a function does in many of the cases. See my individual comments for details. If you are averse to the use of get in function names in this section, what about using compute or calculate instead (this is already done in compute_committee).

specs/core/0_beacon-chain.md Outdated Show resolved Hide resolved
specs/core/0_beacon-chain.md Outdated Show resolved Hide resolved
specs/core/0_beacon-chain.md Show resolved Hide resolved
specs/core/0_beacon-chain.md Outdated Show resolved Hide resolved
specs/core/0_beacon-chain.md Show resolved Hide resolved
@JustinDrake
Copy link
Contributor Author

I tried making BLS_WITHDRAWAL_PREFIX a Bytes1 but broke something. (I think the spec builder is confused somehow.)

@djrtwo
Copy link
Contributor

djrtwo commented Jun 30, 2019

I think we should leave as is instead of the "default" value here. It is a configurable constant that might be changed in the future (or in different deployments)

@djrtwo
Copy link
Contributor

djrtwo commented Jun 30, 2019

I'd prefer to revert to my last commit and get this merged. We have other things to handle that are waiting on this PR

@JustinDrake
Copy link
Contributor Author

I think we should leave as is instead of the "default" value here.

That's fine :) (Tried moving it to see if spec builder would be happier.) Making it Bytes1() is still probably the way forward.

@djrtwo djrtwo merged commit daa624e into dev Jun 30, 2019
@djrtwo djrtwo deleted the helperscleanup branch June 30, 2019 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
milestone:June 30 freeze 🥶 Phase 0 spec freeze for long-lived cross-client testnet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants